veRTCEngine

成员方法

静态方法

方法详情

init

创建和初始化引擎

(appId: string, documentPath: string, params: string) => number

参数

返回值

类型: number

• 0：成功
• !0：失败
  

uninit

销毁引擎

() => number

返回值

类型: number

• 0：成功
• !0：失败
  

setBusinessId

设置业务标识参数

(business_id: string) => number

参数

返回值

类型: number

• 0： 成功。
• <0： 失败
• -6001： 用户已经在房间中。
• -6002： 输入非法，合法字符包括所有小写字母、大写字母和数字，除此外还包括四个独立字符分别是：英文句号，短横线，下划线和 @。
  

注意

• 可通过 business_id 区分不同的业务场景（角色/策略等）。business_id 由客户自定义，相当于一个“标签”，可以分担和细化现在 AppId 的逻辑划分的功能。
• 需要在调用 joinRoom 之前调用，joinRoom 之后调用该方法无效。

joinRoom

创建/加入房间：房间不存在时即创建房间；房间存在时即加入这个房间。

(token: string, room_id: string, uid: string, info: string, roomConfig: RTCRoomConfig) => number

参数

返回值

类型: number

• 0: 成功
• -1: room_id 为空，失败
  
• -2: user_info 为空，失败
  

注意

• 同一房间内的用户间可以相互通话。
• 进房后重复调用无效，用户必须调用 leaveRoom 退出当前房间后，才能加入下一个房间。
• 本地用户调用此方法加入房间成功后，会收到 OnJoinRoomResult 回调通知。
• 本地用户调用 setUserVisibility 将自身设为可见后加入房间，远端用户会收到 OnUserJoined 。+ 使用不同 App ID 的 App 是不能互通的。
• 用户加入房间成功后，在本地网络状况不佳的情况下，SDK 可能会与服务器失去连接，此时 SDK 将会自动重连。重连成功后，本地会收到 OnJoinRoomResult 回调通知。
• 同一个 App ID 的同一个房间内，每个用户的用户 ID 必须是唯一的。如果两个用户的用户 ID 相同，则后进房的用户会将先进房的用户踢出房间，并且先进房的用户会收到 OnError 回调通知，错误类型详见 ErrorCode 中的 kErrorCodeDuplicateLogin。

setUserVisibility

设置用户可见性。默认为可见。

(enable: boolean) => number

参数

返回值

类型: number

• 0：成功
• !0：失败
  

注意

• 通过对用户可见性进行设置，可以控制用户在房间内的行为： + 能否发布音视频流；
  + 用户自身是否在房间中隐身。
• 该方法在加入房间前后均可调用。
• 在房间内调用此方法，房间内其他用户会收到相应的回调通知： - 从 false 切换至 true 时，房间内其他用户会收到 OnUserJoined 回调通知；
  - 从 true 切换至 false 时，房间内其他用户会收到 OnUserLeave 回调通知。
• 若调用该方法将可见性设为 false，此时尝试发布流会收到 OnWarning 警告，具体原因参看 WarningCode 中的 kWarningCodePublishStreamForbiden 警告码。

leaveRoom

离开房间。调用此方法离开房间，结束通话过程，释放所有通话相关的资源。

() => number

返回值

类型: number

• 0：成功
• !0：失败
  

注意

• 加入房间后，必须调用此方法结束通话，否则无法开始下一次通话。无论当前是否在房间内，都可以调用此方法。重复调用此方法没有负面影响。
• 此方法是异步操作，调用返回时并没有真正退出房间。真正退出房间后，本地会收到 OnLeaveRoom 回调通知。
• 调用 setUserVisibility 将自身设为可见的用户离开房间后，房间内其他用户会收到 OnUserLeave 回调通知。
• 如果调用此方法后立即销毁引擎，SDK 将无法触发 OnLeaveRoom 回调。

updateToken

更新 Token

(token: string) => number

参数

返回值

类型: number

• 0：成功
• !0：失败
  

注意

• Token 有一定的有效期，当 Token 过期时，用户需调用此方法更新房间的 Token 信息。
• 用户调用 joinRoom 方法加入房间时，如果使用了过期的 Token 将导致加入房间失败，并会收到 OnJoinRoomResult 回调通知，错误码为 ErrorCode.kErrorCodeInvalidToken 。此时需要重新获取 Token，并调用此方法更新 Token。
• 如果用户因 Token 过期导致加入房间失败，则调用此方法更新 Token 后，SDK 会自动重新加入房间，而不需要用户自己调用 joinRoom 方法。

setPlaybackVolume

调节本地播放的所有远端用户混音后的音量

(volume: number) => number

参数

返回值

类型: number

• 0：成功
• !0：失败
  

注意

为保证更好的通话质量，建议将 volume 值设为 [0,100]。

startAudioCapture

开启内部音频采集。默认为关闭状态。

() => number

返回值

类型: number

• 0：成功
• !0：失败
  

注意

• 进房前调用该方法，本地用户会收到 OnMediaDeviceStateChanged 的回调。
• 进房后调用该方法，房间中的其他用户会收到 OnUserStartAudioCapture 的回调。
• 若未取得当前设备的麦克风权限，调用该方法后会触发 OnWarning 回调。
• 调用 stopAudioCapture 可以关闭音频采集设备，否则，SDK 只会在销毁引擎的时候自动关闭设备。
• 无论是否发布音频数据，你都可以调用该方法开启音频采集，并且调用后方可发布音频。
• 尚未进房并且已使用自定义采集时，关闭自定义采集后并不会自动开启内部采集。你需调用此方法手动开启内部采集。

stopAudioCapture

关闭内部音频采集。默认为关闭状态。

() => number

返回值

类型: number

• 0：成功
• !0：失败
  

注意

• 进房前调用该方法，本地用户会收到 OnMediaDeviceStateChanged 的回调。
• 进房后调用该方法后，房间中的其他用户会收到 OnUserStopAudioCapture 的回调。
• 调用 startAudioCapture 可以开启音频采集设备。
• 设备开启后若一直未调用该方法关闭，则 SDK 会在销毁引擎的时候自动关闭音频采集设备。

muteLocalAudio

控制本地音频流的发送状态：发送/不发送

(muteState: number) => number

参数

返回值

类型: number

• 0：成功
• !0：失败
  

注意

• 使用此方法后，房间中的其他用户会收到回调： OnUserMuteAudio
• 本方法仅控制本地音频流的发送状态，并不影响本地音频采集状态。

setAudioVolumeIndicationInterval

开启/关闭音量提示。默认关闭。

(interval: number) => number

参数

返回值

类型: number

• 0：成功
• !0：失败
  
  

注意

• 开启音量提示后，将按设置的时间间隔收到本地采集音量或订阅的远端用户的音量信息回调。
• 关于回调的具体信息，参看 OnAudioVolumeIndication

setRemoteAudioPlaybackVolume

调节来自远端用户的音频播放音量

(strUserId: string, volume: number) => number

参数

返回值

类型: number

• 0：成功
• !0：失败
  

resumeAllSubscribedStream

恢复接收来自远端的媒体流

(type: PauseResumeControlMediaType) => number

参数

返回值

类型: number

• 0：成功
• !0：失败
  

注意

• 该方法仅恢复远端流的接收，并不影响远端流的采集和发送；
• 该方法不改变用户的订阅状态以及订阅流的属性。

startVideoCapture

开启内部视频采集。默认为关闭状态

() => number

返回值

类型: number

• 0：成功
• !0：失败
  

注意

• 调用该方法后，本地用户会收到 OnMediaDeviceStateChanged 的回调。
• 进房后调用该方法后，房间中的其他用户会收到 OnUserStartVideoCapture 的回调。
• 内部视频采集指：使用 RTC SDK 内置视频采集模块，进行采集。
• 若未取得当前设备的摄像头权限，调用该方法会不成功，并触发 OnMediaDeviceStateChanged 回调。
• 调用 stopVideoCapture 可以关闭视频采集设备，否则，SDK 只会在销毁引擎的时候自动关闭设备。
• 无论是否发布视频数据，你都可以调用该方法开启视频采集，并且调用后方可发布视频。
• 如果需要从自定义视频采集切换为内部视频采集，你必须先关闭自定义采集，再调用此方法手动开启内部采集。

stopVideoCapture

关闭内部视频采集。默认为关闭状态。

() => number

返回值

类型: number

• 0：成功
• !0：失败
  

注意

• 调用该方法后，本地用户会收到 OnMediaDeviceStateChanged 的回调。
• 进房后调用该方法后，房间中的其他用户会收到 OnUserStopVideoCapture 的回调。
• 调用 startVideoCapture 可以开启视频采集设备。
• 设备开启后若一直未调用此方法关闭本地视频采集，则 SDK 会在销毁引擎的时候自动关闭。

setVideoEncoderConfig

启动推送多路视频流，设置推送多路流时的各路视频参数，包括分辨率、帧率、码率、缩放模式、网络不佳时的回退策略等。

(index: number, solutions: VideoSolution[]) => number

参数

返回值

类型: number

• 0：成功
• !0：失败
  

注意

• 当使用内部采集时，视频采集的分辨率、帧率会根据编码参数进行适配。
• 默认的视频编码参数为：分辨率 640px * 360px，帧率 15fps。
• 变更编码分辨率后马上生效，可能会引发相机重启。
• 屏幕流只取视频参数数组的第一组数据。

muteLocalVideo

停止/启动发送本地视频流，默认不发送。

(muteState: number) => number

参数

返回值

类型: number

• 0：成功
• !0：失败
  

注意

• 无论你使用内部视频采集，还是自定义视频采集，你都应使用此接口启动发送本地视频流。
• 调用该方法后，房间中的其他用户会收到 OnUserMuteVideo 的回调。
• 本方法只是停止/启动本地视频流的发送，不影响视频采集状态。
• 无论是否开启视频采集，你都可以启动发送本地视频流。这样，一旦开始采集视频，即可进行发送。

switchCamera

切换视频内部采集时使用的前置/后置摄像头。默认使用前置摄像头。

(camera_id: number) => number

参数

返回值

类型: number

• 0：成功
• !0：失败
  

注意

• 调用此接口后，在本地会触发 OnMediaDeviceStateChanged 回调。
• 如果你正在使用相机进行视频采集，切换操作当即生效；如果相机未启动，后续开启内部采集时，会打开设定的摄像头。
• 如果本地有多个摄像头且想选择特定工作摄像头可通过 IVideoDeviceManager 来控制。

setLocalVideoMirrorMode

设置采用前置摄像头采集时，是否开启镜像模式。

(nMode: MirrorMode) => number

参数

返回值

类型: number

• 0：成功
• !0：失败
  

pauseAllSubscribedStream

暂停接收来自远端的媒体流。

(type: PauseResumeControlMediaType) => number

参数

返回值

类型: number

• 0：成功
• !0：失败
  

注意

• 该方法仅暂停远端流的接收，并不影响远端流的采集和发送；
• 该方法不改变用户的订阅状态以及订阅流的属性。
• 若想恢复接收远端流，需调用 resumeAllSubscribedStream 。

startScreenVideoCapture

采集屏幕视频流，用于共享。屏幕视频流包括：屏幕上显示的内容，应用窗口中显示的内容，或虚拟屏幕中显示的内容。其中，虚拟屏幕中显示的内容仅在 Windows 平台上支持。

(info: ScreenCaptureSourceInfo, params: ScreenCaptureParameters) => number

参数

返回值

类型: number

• 0：成功
• !0：失败
  

注意

• 调用此方法仅开启屏幕流视频采集，不会发布采集到的视频。发布屏幕流视频需要调用 publishScreen 。
• 要关闭屏幕视频源采集，调用 stopScreenVideoCapture 。
• 调用成功后，本端会收到 OnFirstLocalVideoFrameCaptured 回调。然后通过调用 setupLocalScreen 设置本地屏幕共享视图。
• 调用此接口前，你可以调用 setVideoEncoderConfig 设置屏幕视频流的采集帧率和编码分辨率。
• 监听 OnLocalScreenFrame 本地屏幕视频回调事件

updateScreenCaptureRegion

更新屏幕共享区域。

(regionRect: Rectangle) => number

参数

返回值

类型: number

• 0：成功
• !0：失败
  

UpdateScreenCaptureMouseCursor

通过 RTC SDK 提供的采集模块采集屏幕视频流时，更新对鼠标的处理设置。默认采集鼠标。

(state: MouseCursorCaptureState) => number

参数

返回值

类型: number

• 0：成功
• !0：失败
  

注意

调用此接口前，必须已通过调用 startScreenVideoCapture 开启了内部屏幕流采集。

updateScreenCaptureHighlightConfig

通过 RTC SDK 提供的采集模块采集屏幕视频流时，更新边框高亮设置。默认展示表框。

(highlight_config: HighlightConfig) => number

参数

返回值

类型: number

• 0：成功
• !0：失败
  

注意

调用此接口前，必须已通过调用 startScreenVideoCapture 开启了内部屏幕流采集。

updateScreenCaptureFilterConfig

通过 RTC SDK 提供的采集模块采集屏幕视频流时，设置需要过滤的窗口。

(screenFilterConfig: number[]) => number

参数

返回值

类型: number

• 0：成功
• !0：失败
  

注意

• 调用此接口前，必须已通过调用 startScreenVideoCapture 开启了内部屏幕流采集。
• 本函数在屏幕源类别是屏幕而非应用窗体时才起作用。详见： ScreenCaptureSourceType

stopScreenVideoCapture

停止屏幕视频流采集。

() => number

返回值

类型: number

• 0：成功
• !0：失败
  

注意

• 要开启屏幕视频流采集，调用 startScreenVideoCapture
• 调用此接口不影响屏幕视频流发布。

getScreenCaptureSourceList

获取屏幕采集对象列表。

() => ScreenCaptureSourceInfo[]

返回值

类型: ScreenCaptureSourceInfo[]

屏幕采集对象列表，包括应用窗口和屏幕。由用户选择其中一个共享对象，并在调用 startScreenVideoCapture 时作为参数传给 RTC SDK。

getThumbnail

获取共享对象缩略图

(type: ScreenCaptureSourceType, sourceId: number, maxWidth: number, maxHeight: number) => ThumbnailInfo

参数

返回值

类型: ThumbnailInfo

共享对象缩略图

getWindowAppIcon

获取应用窗体所属应用的图标。

(sourceId: number, maxWidth: number, maxHeight: number) => AppIconInfo

参数

返回值

类型: AppIconInfo

应用窗体所属应用的图标。当屏幕共享对象为应用窗体时有效，否则返回 nullptr。

publishScreen

发布本地屏幕共享流到房间。

() => number

返回值

类型: number

• 0：成功
• !0：失败
  

注意

• 你必须先加入房间，才能调用此方法。
• 直播、游戏、云游戏房间模式下，仅可见的用户可以调用此方法。你可以调用 setUserVisibility 方法设置用户在房间中的可见性。
• 此方法只影响屏幕共享视频流的发布状态，并不影响屏幕视频流的采集情况。参看 startScreenVideoCapture 和 StartScreenAudioCapture
• 发布成功后，远端会收到 OnStreamAdd 回调和 OnRemoteScreenFrame 回调。
• 调用 unpublishScreen 取消发布。

unpublishScreen

停止发布本地屏幕共享流到房间。

() => number

返回值

类型: number

• 0：成功
• !0：失败
  

注意

• 远端会收到 OnStreamRemove 事件。
• 此方法只影响屏幕共享视频流的发布状态，并不影响屏幕视频流的采集情况。
• 调用 publishScreen 启动发布。

setCaptureVolume

调节音频采集音量

(index: number, volume: number) => number

参数

返回值

类型: number

• 0：成功
• !0：失败
  

注意

• 无论是采集来自麦克风的音频流，还是屏幕音频流；无论是 RTC SDK 内部采集，还是自定义采集，都可以使用此接口进行音量调节。
• 在开启音频采集前后，你都可以使用此接口设定采集音量。

startAudioMixing

开始播放音乐文件及混音

(id: number, file_path: string, mixingconfig: AudioMixingConfig) => number

参数

返回值

类型: number

• 0：成功
• !0：失败
  

注意

• 调用本方法成功播放音乐文件后，SDK 会向本地回调当前的混音状态，见 OnAudioMixingStateChanged 。
• 开始播放音乐文件及混音后，可以调用 stopAudioMixing 方法停止播放音乐文件。

stopAudioMixing

停止播放音乐文件及混音

(id: number) => number

参数

返回值

类型: number

• 0：成功
• !0：失败
  

注意

• 调用 startAudioMixing 方法开始播放音乐文件及混音后，可以调用本方法停止播放音乐文件及混音。
• 调用本方法停止播放音乐文件后，SDK 会向本地回调通知已停止混音，见 OnAudioMixingStateChanged 。
• 调用本方法停止播放音乐文件后，该音乐文件会被自动卸载。

pauseAudioMixing

暂停播放音乐文件及混音

(id: number) => number

参数

返回值

类型: number

• 0：成功
• !0：失败
  

注意

• 调用 startAudioMixing 方法开始播放音乐文件及混音后，可以通过调用本方法暂停播放音乐文件及混音。
• 调用本方法暂停播放音乐文件及混音后，可调用 resumeAudioMixing 方法恢复播放及混音。
• 调用本方法暂停播放音乐文件后，SDK 会向本地回调通知已暂停混音，见 OnAudioMixingStateChanged 。

resumeAudioMixing

恢复播放音乐文件及混音

(id: number) => number

参数

返回值

类型: number

• 0：成功
• !0：失败
  

注意

• 调用 pauseAudioMixing 方法暂停播放音乐文件及混音后，可以通过调用本方法恢复播放及混音。
• 调用本方法恢复播放音乐文件及混音后，SDK 会向本地回调通知音乐文件正在播放中，见 OnAudioMixingStateChanged 。

setAudioMixingVolume

调节音乐文件在本地和远端播放的音量大小

(id: number, volume: number, type: number) => number

参数

返回值

类型: number

• 0：成功
• !0：失败
  

注意

• 调用本方法设置音量前，请先调用 preloadAudioMixing 或 startAudioMixing 。
• 为保证更好的音质，建议将 volume 值设为 [0,100]。

getAudioMixingDuration

获取音乐文件时长

(id: number) => number

参数

返回值

类型: number

• >0: 成功, 音乐文件时长，单位为毫秒。
• <0: 失败
  

注意

调用本方法获取音乐文件时长前，需要先调用 preloadAudioMixing 或 startAudioMixing 。

getAudioMixingCurrentPosition

获取音乐文件播放进度

(id: number) => number

参数

返回值

类型: number

• >0: 成功, 音乐文件播放进度，单位为毫秒。
• <0: 失败
  

注意

调用本方法获取音乐文件播放进度前，需要先调用 startAudioMixing 开始播放音乐文件。

setAudioMixingPosition

设置音乐文件的播放位置

(id: number, pos: number) => number

参数

返回值

类型: number

• 0：成功
• !0：失败
  

注意

• 本方法可以设置音乐文件的播放位置，这样你可以根据实际情况从指定的位置播放音乐文件，无需从头到尾完整播放一个音乐文件。
• 调用本方法设置音乐文件的播放位置前，需要先调用 StartAudioMixing 开始播放音乐文件。

preloadAudioMixing

预加载指定音乐文件到内存中

(id: number, file_path: string) => number

参数

返回值

类型: number

• 0：成功
• !0：失败
  

注意

• 需要频繁播放某个音乐文件的时候，调用本方法预加载该文件，在播放的时候可以只加载一次该文件，减少 CPU 占用。
  
• 本方法只是预加载指定音乐文件，只有调用 startAudioMixing 方法才开始播放指定音乐文件。
  
• 调用本方法预加载音乐文件后，SDK 会回调通知音乐文件已加载，见 OnAudioMixingStateChanged 。
  
• 调用本方法预加载的指定音乐文件可以通过 unloadAudioMixing 卸载。

unloadAudioMixing

卸载指定音乐文件

(id: number) => number

参数

返回值

类型: number

• 0：成功
• !0：失败
  

注意

不论音乐文件是否播放，调用本方法卸载该文件后，SDK 会回调通知混音已停止，见 OnAudioMixingStateChanged 。

enumerateVideoCaptureDevices

获取当前系统内视频采集设备列表。

() => Object

返回值

类型: Object

包含系统中所有视频采集设备的列表和相关信息

setVideoCaptureDevice

设置当前视频采集设备

(deviceId: string) => number

参数

返回值

类型: number

• 0：方法调用成功
• !0：方法调用失败
  

getVideoCaptureDevice

获取当前 SDK 正在使用的视频采集设备信息

() => string

返回值

类型: string

当前 SDK 正在使用的视频采集设备信息

enumerateAudioPlaybackDevices

获取当前系统内音频播放设备列表。如果后续设备有变更，你会收到 OnMediaDeviceStateChanged 回调通知，然后需要重新调用本接口以获得新的设备列表。

() => Object

返回值

类型: Object

包含系统中所有音频播放设备的列表和相关信息

enumerateAudioCaptureDevices

获取当前系统内音频采集设备列表。如果后续设备有变更，你需要重新调用本接口以获得新的设备列表。

() => Object

返回值

类型: Object

包含系统中所有音频采集设备列表和相关信息

setAudioPlaybackDevice

设置音频播放设备。

(deviceId: string) => number

参数

返回值

类型: number

方法调用结果

• 0：方法调用成功
• <0：方法调用失败
  

setAudioCaptureDevice

设置音频采集设备。

(deviceId: string) => number

参数

返回值

类型: number

方法调用结果

• 0：方法调用成功
• <0：方法调用失败
  

getAudioPlaybackDevice

获取当前音频播放设备 ID。

() => string

返回值

类型: string

当前音频播放设备 ID

getAudioCaptureDevice

获取当前音频采集设备 ID。

() => string

返回值

类型: string

当前音频采集设备 ID

startAudioPlaybackDeviceTest

启动音频播放设备测试。
该方法测试播放设备是否能正常工作。SDK 播放指定的音频文件，测试者如果能听到声音，说明播放设备能正常工作。

(test_audio_file_path: String) => number

参数

返回值

类型: number

方法调用结果

• 0：方法调用成功
  
• <0：方法调用失败
  
  

注意

• 该方法必须在 JoinRoom 前调用，且不可与其它音频设备测试功能同时应用。
  
• 你需调用 StopAudioPlaybackDeviceTest 停止测试。
  

stopAudioPlaybackDeviceTest

停止音频播放设备测试。

() => number

返回值

类型: number

方法调用结果

• 0：方法调用成功
  
• <0：方法调用失败
  
  

注意

调用 StartAudioPlaybackDeviceTest 后，需调用本方法停止测试。

startAudioCaptureDeviceTest

启动音频采集设备测试。 该方法测试音频采集设备是否能正常工作。启动测试后，会收到 OnAudioVolumeIndication 回调上报的音量信息。

(indication_interval: number) => number

参数

返回值

类型: number

方法调用结果

• 0：方法调用成功
  
• <0：方法调用失败
  
  

注意

• 该方法必须在 joinRoom 前调用，且不可与其它音频设备测试功能同时应用。
  
• 你需调用 stopAudioCaptureDeviceTest 停止测试。
  

stopAudioCaptureDeviceTest

停止音频采集设备测试。

() => number

返回值

类型: number

方法调用结果

• 0：方法调用成功
  
• <0：方法调用失败
  
  

注意

调用 startAudioCaptureDeviceTest 后，需调用本方法停止测试。

setAudioPlaybackDeviceVolume

设置当前音频播放设备音量

(volume: number) => number

参数

返回值

类型: number

方法调用结果

• 0：方法调用成功
• <0：方法调用失败
  

getAudioPlaybackDeviceVolume

获取当前音频播放设备音量

() => number

返回值

类型: number

方法调用结果

• 0：方法调用成功
• <0：方法调用失败
  

setAudioCaptureDeviceVolume

设置当前音频采集设备音量

(volume: number) => number

参数

返回值

类型: number

方法调用结果

• 0：方法调用成功
• <0：方法调用失败
  

getAudioCaptureDeviceVolume

获取当前音频采集设备音量

() => number

返回值

类型: number

方法调用结果

• 0：方法调用成功
• <0：方法调用失败
  

startAudioDeviceLoopbackTest

开始音频设备回路测试。
该方法测试音频采集设备和音频播放设备是否能正常工作。一旦测试开始，音频采集设备会采集本地声音，并通过音频播放设备播放出来，同时用户 App 会收到 OnAudioVolumeIndication 回调上报的音量信息。

(indication_interval: number) => number

参数

返回值

类型: number

方法调用结果

• 0：方法调用成功
• <0：方法调用失败
  

注意

• 该方法必须在 JoinRoom 前调用。且不可与其它音频设备测试功能同时应用。
• 你需调用 StopAudioDeviceLoopbackTest 停止测试。
• 该方法仅在本地进行音频设备测试，不涉及网络连接。

stopAudioDeviceLoopbackTest

停止音频设备回路测试。

() => number

返回值

类型: number

方法调用结果

• 0：方法调用成功
• <0：方法调用失败
  

注意

调用 StartAudioDeviceLoopbackTest 后，需调用本方法停止测试。

initAudioPlaybackDeviceForTest

尝试初始化音频播放设备，可检测出设备不存在、权限被拒绝/禁用等异常问题。

(deviceId: string) => number

参数

返回值

类型: number

设备状态错误码

• 0: 设备检测结果正常
• -1: 接口状态不正确，例如在正常启动采集后再调用该接口进行检测
• -2: 采集设备无麦克风权限，尝试初始化设备失败
• -3: 设备不存在，当前没有设备或设备被移除时返回
• -4: 设备音频格式不支持
• -5: 其它原因错误
  

注意

1. 该接口需在进房前调用；
2. 检测成功不代表设备一定可以启动成功，还可能因设备被其他应用进程独占，或 CPU/内存不足等原因导致启动失败。

initAudioCaptureDeviceForTest

尝试初始化音频播放设备，可检测出设备不存在、权限被拒绝/禁用等异常问题。

(deviceId: string) => number

参数

返回值

类型: number

设备状态错误码

• 0: 设备检测结果正常
• -1: 接口状态不正确，例如在正常启动采集后再调用该接口进行检测
• -2: 采集设备无麦克风权限，尝试初始化设备失败
• -3: 设备不存在，当前没有设备或设备被移除时返回
• -4: 设备音频格式不支持
• -5: 其它原因错误
  

注意

1. 该接口需在进房前调用；
2. 检测成功不代表设备一定可以启动成功，还可能因设备被其他应用进程独占，或 CPU/内存不足等原因导致启动失败。

setAudioPlaybackDeviceMute

设置当前音频播放设备静音状态，默认为非静音。

(mute: boolean) => number

参数

返回值

类型: number

方法调用结果

• 0：方法调用成功
• <0：方法调用失败
  

getAudioPlaybackDeviceMute

获取当前音频播放设备是否静音的信息。

() => boolean

返回值

类型: boolean

方法调用结果

• true：方法调用成功
• false：方法调用失败
  

setAudioCaptureDeviceMute

设置当前音频采集设备静音状态，默认为非静音。

(mute: boolean) => number

参数

返回值

类型: number

方法调用结果

• 0：方法调用成功
  
• <0：方法调用失败
  
  

getAudioCaptureDeviceMute

获取当前音频采集设备是否静音的信息。

() => boolean

返回值

类型: boolean

• true：静音
  
• false：非静音
  

setPublishFallbackOption

设置发布的音视频流回退选项 。
你可以调用这个接口来设置网络情况不佳或设备性能不足时只发送小流，以保证通话质量。

(option: number) => number

参数

返回值

类型: number

• 0: 方法调用成功
• <0: 方法调用失败
  

注意

• 这个方法只在设置了发送多个流的情况下有效。
• 你必须在进房前设置，进房后设置或更改设置无效。
• 设置回退选项后，本端发布的音视频流发生回退或从回退中恢复时，订阅该音视频流的客户端会收到 OnSimulcastSubscribeFallback 回调通知。
• 你可以调用 API 或者在服务端下发策略设置回退。当使用服务端下发配置实现时，下发配置优先级高于在客户端使用 API 设定的配置。

setSubscribeFallbackOption

设置订阅的音视频流回退选项。
你可以通过调用该接口来设置网络情况不佳或性能不足时只订阅小流或音频流，以保证通话质量。

(option: number) => number

参数

返回值

类型: number

方法调用结果

• 0：方法调用成功
• <0：方法调用失败
  

注意

• 你必须在进房前设置，进房后设置或更改设置无效。
• 设置回退选项后，本端订阅的音视频流发生回退或从回退中恢复时,会收到 OnSimulcastSubscribeFallback 回调通知。
• 设置回退选项后，本端订阅的视频流因为回退分辨率发生变化时,会收到 OnRemoteVideoSizeChanged 回调通知。
• 你可以调用 API 或者在服务端下发策略设置回退。当使用服务端下发配置实现时，下发配置优先级高于在客户端使用 API 设定的配置。

setRemoteUserPriority

设置用户优先级

(userId: string, priority: RemoteUserPriority) => number

参数

返回值

类型: number

• 0: 方法调用成功
• <0: 方法调用失败
  

注意

• 1. 该方法与 setSubscribeFallbackOption 搭配使用。
• 1. 如果开启了订阅流回退选项，弱网或性能不足时会优先保证收到的高优先级用户的流的质量。
• 1. 该方法在进房前后都可以使用，可以修改远端用户的优先级。

publish

在当前房间内手动开始发布本地音视频流

() => number

返回值

类型: number

• 0: 方法调用成功
• <0: 方法调用失败
  

注意

• 如果你已经在用户进房时通过调用 joinRoom 选择了自动发布，则无需再调用本接口。
  
• 调用 setUserVisibility 方法将自身设置为不可见后无法调用该方法，需将自身切换至可见后方可调用该方法发布音视频流。
  
• 同一用户，同一时间，只能在一个房间内发流。如果你需要发布屏幕共享流，调用 publishScreen 。
• 用户调用此方法成功发布音视频流后，房间中的其他用户将会收到 OnStreamAdd 回调通知。

unpublish

在当前房间内停止发布本地音视频流。

() => number

返回值

类型: number

• 0: 方法调用成功
• <0: 方法调用失败
  

注意

• 调用 publish 手动发布音视频流后或在用户进房时设置为自动发布，都可以调用此接口停止发布。
  
• 用户调用此方法停止发布音视频流后，房间中的其他用户将会收到 OnStreamRemove 回调通知。

subscribeUserStream

订阅房间内指定的远端音视频流。 或更新已经订阅的流的属性、媒体类型等配置。

(user_id: string, stream_type: number, media_type: number, subConfig: SubscribeVideoConfig) => number

参数

返回值

类型: number

• 0: 方法调用成功
• <0: 方法调用失败
  

注意

• 无论是自动订阅还是手动订阅模式，你都可以调用此方法按需订阅房间中的音视频流。
• 你可以通过 OnStreamAdd 和 OnStreamRemove 两个回调获取当前房间你的音视频流信息，并调用本方法按需订阅流或修改订阅配置。
• 若订阅失败，你会收到 OnRoomError 回调通知，具体失败原因参看 ErrorCode 。
• 若调用 pauseAllSubscribedStream 暂停接收远端音视频流，此时仍可使用该方法对暂停接收的流进行设置，你会在调用 resumeAllSubscribedStream 恢复接收流后收到修改设置后的流。

unsubscribe

停止订阅指定的房间内远端音视频流。无论自动订阅还是手动订阅模式，你都可以调用此方法取消已订阅的音视频流。

(userId: string, isScreen: boolean) => number

参数

返回值

类型: number

• 0: 方法调用成功
• <0: 方法调用失败
  

注意

无论是否订阅了指定的远端音视频流，都可以调用此方法。userId 无效或未订阅时，SDK 不会做任何处理，没有负面影响。

sendUserMessage

给房间内指定的用户发送消息，返回这次发送消息的编号。
调用该函数后会收到一次 userMessageSendResult 回调，告知发送结果。

(userId: string, message: string) => number

参数

返回值

类型: number

这次发送消息的编号，从 1 开始递增。

注意

• 调用该函数后会收到一次 userMessageSendResult 回调；
• 若消息发送成功，则 uid 所指定的用户会收到 userMessageReceived 回调。

sendUserBinaryMessage

给房间内指定的用户发送二进制消息（P2P）

(uid: string, length: number, message: Uint8Array) => number

参数

返回值

类型: number

这次发送消息的编号，从 1 开始递增。

注意

• 在发送房间内二进制消息前，必须先调用 joinRoom 加入房间。
  
• 调用该函数后会收到一次 OnUserMessageSendResult 回调，通知消息发送方发送成功或失败；
  
• 若二进制消息发送成功，则 uid 所指定的用户会收到 OnUserBinaryMessageReceived 回调。

setRecordingAudioFrameParameters

设置本地麦克风录制的音频数据回调参数

(sample_rate: number, channels: number) => number

参数

返回值

类型: number

• 0: 方法调用成功
• <0: 方法调用失败
  

注意

使用本方法设置参数后可以在 OnRecordAudioFrame 收到数据

setPlaybackAudioFrameParameters

设置远端所有用户音频数据混音后的音频数据回调参数

(sample_rate: number, channels: number) => number

参数

返回值

类型: number

• 0: 方法调用成功
• <0: 方法调用失败
  

注意

使用本方法设置参数后可以在 OnPlaybackAudioFrame 收到数据

setMixedAudioFrameParameters

设置本地麦克风录制音频数据和远端所有用户音频数据混音后的音频数据回调参数

(sample_rate: number, channels: number) => number

参数

返回值

类型: number

• 0: 方法调用成功
• <0: 方法调用失败
  

注意

使用本方法设置参数后可以在 OnMixedAudioFrame 收到数据

startFileRecording

该方法将通话过程中的音视频数据录制到本地的文件中。

(type: Number, config: RecordingConfig) => number

参数

返回值

类型: number

• 0: 正常
• -1: 参数设置异常
• -2: 当前版本 SDK 不支持该特性，请联系技术支持人员
  

注意

• 调用该方法后，你会收到 OnRecordingStateUpdate 回调。
  
• 如果录制正常，系统每秒钟会通过 OnRecordingProgressUpdate 回调通知录制进度。

stopFileRecording

停止本地录制

(type: Number) => number

参数

返回值

类型: number

• 0: 方法调用成功
• <0: 方法调用失败
  

注意

• 调用 startFileRecording 开启本地录制后，你必须调用该方法停止录制。
  
• 调用该方法后，你会收到 OnRecordingStateUpdate 回调提示录制结果。

startASR

开启自动语音识别服务。该方法将识别后的用户语音转化成文字，并通过 OnMessage 事件回调给用户。

(asr_config: RTCASRConfig) => number

参数

返回值

类型: number

• 0: 方法调用成功
• <0: 方法调用失败
  

stopASR

关闭语音识别服务

() => number

返回值

类型: number

• 0: 方法调用成功
• <0: 方法调用失败
  

sendRoomMessage

给房间内所有的用户发送消息。

(message: string) => number

参数

返回值

类型: number

• 0: 方法调用成功
• <0: 方法调用失败
  

注意

• 调用该函数后会收到一次 roomMessageSendResult 回调；
• 同一房间内的其他用户会收到 roomMessageReceived 回调。

sendRoomBinaryMessage

给房间内的所有其他用户发送广播消息。

(size: number, message: Uint8Array) => number

参数

返回值

类型: number

• 0: 方法调用成功

• <0: 方法调用失败
  

注意

• 在发送房间内二进制消息前，必须先调用 joinRoom 加入房间。
  
• 调用该函数后，会收到一次 OnRoomMessageSendResult 回调。
  
• 同一房间内的其他用户会收到 OnRoomBinaryMessageReceived 回调。

login

必须先登录注册一个 uid，才能发送房间外消息和向业务服务器发送消息

(token: String, uid: String) => number

参数

返回值

类型: number

• 0: 方法调用成功
• <0: 方法调用失败
  

注意

• 在调用本接口登录后，如果想要登出，需要调用 Logout 。
  
• 本地用户调用此方法登录后，会收到 OnLoginResult 回调通知登录结果，远端用户不会收到通知。

logout

调用本接口登出后，无法调用房间外消息以及端到服务器消息相关的方法或收到相关回调。

() => number

返回值

类型: number

• 0: 方法调用成功
• <0: 方法调用失败
  

注意

• 调用本接口登出前，必须先调用 login 登录。
  
• 本地用户调用此方法登出后，会收到 OnLogout 回调通知结果，远端用户不会收到通知。

updateLoginToken

更新用户用于登录的 Token
Token 有一定的有效期，当 Token 过期时，需调用此方法更新登录的 Token 信息。
调用 login 方法登录时，如果使用了过期的 Token 将导致登录失败，并会收到 OnLoginResult 回调通知，错误码为 kLoginErrorCodeInvalidToken。此时需要重新获取 Token，并调用此方法更新 Token。

(token: String) => number

参数

| token | String | 是 | |

更新的动态密钥 |

返回值

类型: number

• 0: 方法调用成功
• <0: 方法调用失败
  

注意

• 如果 Token 无效导致登录失败，则调用此方法更新 Token 后，SDK 会自动重新登录，而用户不需要自己调用 login 方法。
  
• Token 过期时，如果已经成功登录，则不会受到影响。Token 过期的错误会在下一次使用过期 Token 登录时，或因本地网络状况不佳导致断网重新登录时通知给用户。

setServerParams

设置业务服务器参数
客户端调用 sendServerMessage 或 sendServerBinaryMessage 发送消息给业务服务器之前，必须设置有效签名和业务服务器地址。

(signature: String, url: String) => number

参数

返回值

类型: number

• 0: 方法调用成功
• <0: 方法调用失败
  

注意

• 用户必须调用 login 登录后，才能调用本接口。
  
• 调用本接口后，SDK 会使用 OnServerParamsSetResult 返回相应结果。

getPeerOnlineStatus

查询对端用户或本端用户的登录状态

(peer_user_id: String) => number

参数

返回值

类型: number

• 0: 方法调用成功
• <0: 方法调用失败
  

注意

• 必须调用 login 登录后，才能调用本接口。
  
• 调用本接口后，SDK 会使用 OnGetPeerOnlineStatus 回调通知查询结果。
  
• 在发送房间外消息之前，用户可以通过本接口了解对端用户是否登录，从而决定是否发送消息。也可以通过本接口查询自己查看自己的登录状态。

SendUserMessageOutsideRoom

给房间外指定的用户发送文本消息（P2P）

(uid: String, message: String) => number

参数

返回值

类型: number

• >0：发送成功，返回这次发送消息的编号，从 1 开始递增
• -1：发送失败，RtcEngine 实例未创建
• -2：发送失败，uid 为空
  

注意

• 在发送房间外文本消息前，必须先调用 login 完成登录。
  
• 用户调用本接口发送文本信息后，会收到一次 OnUserMessageSendResultOutsideRoom 回调，得知消息是否成功发送。
  
• 若文本消息发送成功，则 uid 所指定的用户会通过 OnUserMessageReceivedOutsideRoom 回调收到该消息。

getErrorDescription

获取错误码的描述

(code: number) => string

参数

返回值

类型: string

错误码的描述

注意

该接口是通用功能，调用时不需要依赖引擎对象。

sendUserBinaryMessageOutsideRoom

给房间外指定的用户发送二进制消息（P2P）

(uid: String, length: number, message: String) => number

参数

返回值

类型: number

• 0：发送成功，返回这次发送消息的编号，从 1 开始递增
  

• -1：发送失败，RtcEngine 实例未创建
  
• -2：发送失败，uid 为空
  

注意

• 在发送房间外二进制消息前，必须先调用 login 完成登录。
  
• 用户调用本接口发送二进制消息后，会收到一次 OnUserMessageSendResultOutsideRoom 回调，通知消息是否发送成功。
  
• 若二进制消息发送成功，则 uid 所指定的用户会通过 OnUserBinaryMessageReceivedOutsideRoom 回调收到该条消息。

sendServerMessage

客户端给业务服务器发送文本消息（P2Server）

(message: String) => number

参数

返回值

类型: number

• >0：发送成功，返回这次发送消息的编号，从 1 开始递增
• -1：发送失败，RtcEngine 实例未创建
  

注意

• 在向业务服务器发送文本消息前，必须先调用 Login 完成登录，随后调用 SetServerParams 设置业务服务器。
  
• 调用本接口后，会收到一次 OnServerMessageSendResult 回调，通知消息发送方是否发送成功。
  
• 若文本消息发送成功，则之前调用 SetServerParams 设置的业务服务器会收到该条消息。

sendServerBinaryMessage

客户端给业务服务器发送二进制消息（P2Server）

(length: number, message: String) => number

参数

返回值

类型: number

• >0：发送成功，返回这次发送消息的编号，从 1 开始递增
  
• -1：发送失败，RtcEngine 实例未创建
  

注意

• 在向业务服务器发送二进制消息前，必须先调用 login 完成登录，随后调用 setServerParams 设置业务服务器。
  
• 调用本接口后，会收到一次 OnServerMessageSendResult 回调，通知消息发送方发送成功或失败。
  
• 若二进制消息发送成功，则之前调用 setServerParams 设置的业务服务器会收到该条消息。

setBackgroundSticker

设置和开启虚拟背景功能，

(effectNodePaths: string, source_path: string) => any

参数

返回值

• 0: 调用成功
  
• 1000: 未集成 CV SDK
  
• 1001: 本版本不支持 CV 功能
  
• <0: 调用失败，具体错误码请参考 CV SDK 文档。
  

注意

• 使用背景分割或视频特效的功能前，你必须自行实现获取智能美化特效产品在线许可证的业务逻辑，参考 在线授权说明。
  
• 获取许可证后，建议调用 checkLicense 确认许可证有效，再开始使用背景分割或视频特效功能。
  
• 使用不同的背景图片分别调用本接口，将更新虚拟背景图片。
• 开启虚拟背景功能后，如需关闭，再次调用本接口，并给两个参数赋 null 值。

checkLicense

视频特效许可证检查

(licensePath: string) => number

参数

返回值

类型: number

• 0: 调用成功
  
• 1000: 未集成 CV SDK
  
• 1001: 本版本不支持 CV 功能
  
• <0: 调用失败，具体错误码请参考 CV SDK 文档。
  

注意

开始使用视频特效前，你必须先调用这个方法进行许可证验证

getAuthMessage

从 CV SDK 获取授权消息，用于获取在线许可证。

() => string

返回值

类型: string

授权消息字符串

注意

• 使用背景分割或视频特效的功能前，你必须自行实现获取智能美化特效产品在线许可证的业务逻辑，参考 在线授权说明。
  
• 获取许可证后，建议调用 checkLicense 确认许可证有效，再开始使用背景分割或视频特效功能。
  

enableEffect

开启关闭视频特效

(enabled: boolean) => number

参数

返回值

类型: number

• 0: 调用成功
• 1000: 未集成 CV SDK
• <0: 调用失败，具体错误码含义请参考 CV SDK 文档
  

注意

在调用 checkLicense 和 setAlgoModelPath 后调用此方法

setAlgoModelPath

设置视频特效算法模型路径

(modelPath: string) => number

参数

返回值

类型: number

• 0：成功
• !0：失败
  

setEffectNodes

设置视频特效素材包，支持同时设置多个素材包

(effectNodePaths: string[]) => number

参数

返回值

类型: number

• 0: 调用成功
  
• 1000: 未集成 CV SDK
  
• 1001: 本 RTC 版本不支持 CV 功能
  
• <0: 调用失败，具体错误码，请参考 CV SDK 文档。

updateNode

设置特效强度

(nodePath: string, nodeKey: string, nodeValue: number) => number

参数

返回值

类型: number

• 0: 调用成功
  
• 1000: 未集成 CV SDK
  
• 1001: 本 RTC 版本不支持 CV 功能
  
• <0: 调用失败，具体错误码，请参考 CV SDK 文档。

setColorFilter

设置颜色滤镜

(resPath: string) => number

参数

返回值

类型: number

• 0: 调用成功
  
• 1000: 未集成 CV SDK
  
• 1001: 本 RTC 版本不支持 CV 功能
  
• <0: 调用失败，具体错误码，请参考 CV SDK 文档。

setColorFilterIntensity

设置已启用颜色滤镜的强度

(intensity: number) => number

参数

返回值

类型: number

• 0: 调用成功
  
• 1000: 未集成 CV SDK
  
• 1001: 本 RTC 版本不支持 CV 功能
  
• <0: 调用失败，具体错误码，请参考 CV SDK 文档。

sendSEIMessage

在视频通信时，通过视频帧发送 SEI 数据。

(stream_index: number, message: Uint8Array, repeat_count: number) => number

参数

返回值

类型: number

• >=0: 将被添加到视频帧中的 SEI 的数量
  
• < 0: 发送失败
  

注意

• 如果调用此接口之后的 2s 内，没有可带 SEI 的视频帧（比如没有开启视频采集和传输），那么，SEI 数据不会被加进视频帧中。
• 消息发送成功后，远端会收到 OnSEIMessageReceived 回调。

setScreenAudioStreamIndex

在屏幕共享时，设置屏幕音频流和麦克风采集到的音频流的混流方式

(index: number) => number

参数

返回值

类型: number

注意

你应该在 publishScreen 之前，调用此方法。否则，你将收到 OnWarning 的报错：kWarningCodeSetScreenAudioStreamIndexFailed

startScreenAudioCapture

在屏幕共享时，开始使用 RTC SDK 内部采集方式，采集屏幕音频

() => number

返回值

类型: number

注意

• 采集后，你还需要调用 publishScreen 将采集到的屏幕音频推送到远端。
  
• 要关闭屏幕音频内部采集，调用 stopScreenAudioCapture 。

stopScreenAudioCapture

在屏幕共享时，停止使用 RTC SDK 内部采集方式，采集屏幕音频。

() => number

返回值

类型: number

注意

要开始屏幕音频内部采集，调用 startScreenAudioCapture 。

feedback

本次通话质量打分评价

(data: String) => number

参数

返回值

类型: number

• 0: 上报成功
  
• -1: 上报失败，还没加入过房间
  
• -2: 上报失败，传入 JSON 解析失败
  
  
• -3: 上报失败，传入 JSON 字段缺失
  

注意

• 如果用户上报时在房间内，那么问题会定位到用户当前所在的一个或多个房间；
• 如果用户上报时不在房间内，那么问题会定位到引擎此前退出的房间。

setEncryptInfo

设置传输时使用内置加密的方式

(encrypt_type: number, key: string) => void

参数

注意

该方法必须在进房之前调用，可重复调用，以最后调用的参数作为生效参数。

startLiveTranscoding

开启转推直播，并设置合流的视频视图布局和音频属性。

(param: TranscoderParam) => number

参数

返回值

类型: number

• 0：成功
• !0：失败
  

注意

1.只有房间模式为直播模式的用户才能调用此方法。
2.调用该方法后，关于启动结果和推流过程中的错误，会收到 OnLiveTranscodingResult 回调。 3.调用 stopLiveTranscoding 停止转推直播。

stopLiveTranscoding

停止转推直播。

() => number

返回值

类型: number

• 0：成功
• !0：失败
  

注意

关于启动转推直播，参看 startLiveTranscoding 。

updateLiveTranscoding

更新转推直播参数。

(param: TranscoderParam) => number

参数

返回值

类型: number

• 0：成功
• !0：失败
  

注意

使用 startLiveTranscoding 启用转推直播功能后，使用此方法更新功能配置参数。

setupLocalVideo

为本地采集到的视频流绑定本地渲染视图

(view: HTMLDivElement, renderOptions?: RenderOptions) => number

参数

返回值

类型: number

0：成功
-1: 失败

removeLocalVideo

解绑本地视频流已绑定的渲染视图

() => number

返回值

类型: number

0：成功
-1: 失败

setupRemoteVideo

为远端视频流绑定本地渲染视图

(userId: string, view: HTMLDivElement, renderOptions?: RenderOptions) => number

参数

返回值

类型: number

0：成功
-1: 失败

removeRemoteVideo

解绑指定远端视频流已绑定的本地视图

(userId: string) => number

参数

返回值

类型: number

0：成功
-1: 失败

注意

停止接收远端视频流时应解绑视图

removeAllRemoteVideo

解绑所有已绑定本地视图的指定远端视频流

() => number

返回值

类型: number

0：成功

-1: 失败

注意

停止接收远端视频流时应解绑视图

setupLocalScreen

为本地屏幕共享流绑定视图

(view: HTMLDivElement, renderOptions?: RenderOptions) => number

参数

返回值

类型: number

0：成功

-1: 失败

注意

本地发起屏幕共享需要先绑定视图

removeLocalScreen

解绑屏幕共享流已绑定的视图

() => number

返回值

类型: number

0：成功
!0: 失败

注意

本地停止屏幕共享时解绑视图

setupRemoteScreen

为远端屏幕共享流绑定本地视图

(userId: string, view: HTMLDivElement, renderOptions?: RenderOptions) => number

参数

返回值

类型: number

0：成功

-1: 失败

注意

接收屏幕共享流需要先绑定视图

removeRemoteScreen

解绑远端屏幕共享流已绑定的本地视图

(userId: string) => number

参数

返回值

类型: number

0：成功

-1: 失败

注意

停止接收屏幕共享流时应解绑视图

getSDKVersion

获取当前 SDK 版本信息

() => string

返回值

类型: string

当前 SDK 版本信息

getCurrentProcessId

获取加载引擎进程的 ID 方便调试

() => string

返回值

类型: string

进程的 ID